Release Notes - AI Helper Plugin

1.0.27 (2025-08-26)

• Fixed critical issue with variable replacement in code snippets: Variables are now properly excluded from replacement within <MadCap:codeSnippet>, <code>, and <pre> elements. This prevents corruption of code content, permissions, and technical examples when applying variables to topics containing code snippets.
• Improved code integrity protection: The Apply Variables feature now intelligently filters out code snippet elements before processing, ensuring that technical content remains unchanged while still applying variables to regular text content.
• Fixed track changes setting synchronization: The VariableFileSelector window now properly respects the global track changes setting from the Options window. Previously, the checkbox was hardcoded to "True" and didn't reflect the user's global preference. Now it initializes with the correct global setting and any changes are synchronized back to the global configuration.
• Enhanced browse button navigation: Browse buttons in the Apply Variables to Multiple Topics window now start in the appropriate Flare project folders instead of the computer's root directory. Topic browse starts in the Content folder, and variable browse starts in the Project folder, making file selection much more intuitive.
• New Backup and Restore System: Added comprehensive file backup functionality that automatically creates backups before any ButtonCommand execution, with up to 5 backups maintained per file.
• Smart Diff Viewer: Implemented an intelligent diff algorithm using Longest Common Subsequence (LCS) that accurately detects content changes rather than just position differences. This prevents false "deleted" or "added" entries when content simply moves to different line numbers.
• Color-Coded Change Detection: Enhanced diff viewer with visual indicators - green for added lines, red for removed lines, orange for modified lines, and transparent for unchanged lines.
• Restore Button in Admin Ribbon: Added a "Restore from Backup" button in the Admin group that allows users to select and restore from available backups.
• Backup Selection Window: New XAML-based interface for selecting specific backups to restore, including change summaries and detailed diff viewing capabilities.
• Automatic Backup Management: Backups are automatically created in an "AiHelperBackups" folder within the project directory, with automatic cleanup of old backups to maintain the 5-backup limit.
• Enhanced Variable File Safety: Added intelligent detection and visual warnings for variable files containing duplicate variable definitions. Variable files with multiple definitions for the same variable are now displayed in red text with warning tooltips, and are automatically unselected by default to prevent conflicts. The first definition of a variable is always used when duplicates exist.
• Improved Variable Selection Interface: Streamlined the Apply Variables to Multiple Topics window by removing unnecessary search and browse functionality for variable files, focusing on the core task of selecting which variable sets to apply. Added a clear legend explaining the color coding system for risky vs. safe variable files.

1.0.26

• Fixed a bug where attributes where mistakenly removed from Markdown text containing li > p.
• Settings in the Options window didn't always persist. Fixed now.

1.0.25

New Features

• Introduces ClassFormattingTransformer to map specified CSS classes on span/div/p elements to Markdown formatting (bold, italic, underline, numbered, bulleted). Updates UI and settings to allow user configuration of class lists. Refactors Markdown conversion logic to apply these mappings when enabled, improving control over formatting preservation during copy/export operations.

• Include Snippets/Variables — Options to expand snippet content and variable values in output. Toggle via new commands and checkboxes.

• Loose Variable Matching — Case-insensitive variable replacement; treats spaces and non-breaking spaces as equal. Improved options UI and layout.

• Use Regular HTML Links — Option to output <a href> tags instead of MadCap xref elements. Technical Updates

• All related Markdown conversion functions updated to respect new settings.

• All new options persist in the registry.

• UI updated for clarity and usability.

1.0.24

• Fixed a bug where the plugin would crash if you tried to apply variables to a variable file.

1.0.23

• Fixed a problem with the installer.

1.0.22

• Fixed a problem with the installer.

1.0.21

• Fixed an broken link in the GUI.

1.0.20

• Fixed a bug where the free trial would not automaticall activate.

1.0.19

• Fixed a bug where the license would reset every Monday.

1.0.18

• Fixed a bug where snippets would not convert correctly in some cases.
• Added support for nested snippets.
• Xrefs are now converted to markdown links.

1.0.17

• Performance optimizations.

1.0.16

• Fixed a bug where Markdown links would accidentally be converted to MadCap:keyword.

1.0.15

• Fixed a bug where all variables would not be applied if the texts appeared in the same text node.

1.0.14

• Fixed a bug where the plugin would crash if you had a partial text selection with a variable in it.
• When adding files using the Search and Compile window, existing files are now kept when you trigger a new search.
• When searching for files, variables are now parsed run-time so that you can search variables as well.
• Added "Split by H1" as an option when splitting topics.

1.0.13

• Fixed a bug related to replacing variables.

1.0.12

• Fixed a bug related to XHTML pasting.

1.0.11

• Fixed a bug related to selection.

1.0.10

• Fixed a bug that was causing the replace and insert commands to fail.

1.0.9

• Bug fixes.

1.0.8

• Added "clear all" and "select all" to the Apply Variables window.
• You can now apply variables to multiple files at the same time.
• You can now copy the underlying XHTML of a topic or a selection, and either insert or replace XHTML into your topics again.